<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>ProgressbarControl v1.0 Reference</title>
    <link rel="stylesheet" type="text/css" href="http://code.google.com/css/codesite.css"></link>
    <link rel="stylesheet" type="text/css" href="../../util/docs/template/local_extensions.css"></link>
  </head>
  <body>
    <h1>ProgressbarControl</h1>
    <p>
Creates a progress bar control for usage in google maps.   It can be used to show the progress of loading markers, for example.</p>
    <p>For a description and examples of how to use this library, check out the <a href="examples.html">how-to</a>.</p>
    
      <h2><a name="ProgressbarControl"></a>class ProgressbarControl</h2>
      <p></p>
      
        <h3>Constructor</h3>
        <table summary="class ProgressbarControl - Constructor" width="90%">
          
          <tbody>
            <tr>
              <th>Constructor</th>
              
              <th>Description</th>
            </tr>
            
              <tr class="odd">
                <td><code>ProgressbarControl(<span class="type">Map:GMap2</span>, <span class="type">opt_opts:ProgressbarOptions</span>)</code></td>
                
                <td>Creates a progress bar control on the given map, with the given options.</td>
              </tr>
            
          </tbody>
        </table>
      
        <h3>Methods</h3>
        <table summary="class ProgressbarControl - Methods" width="90%">
          
          <tbody>
            <tr>
              <th>Methods</th>
              
                
                  <th>Return&nbsp;Value</th>
                
              
              <th>Description</th>
            </tr>
            
              <tr class="odd">
                <td><code>remove()</code></td>
                
                  
                    <td><code>None</code></td>
                  
                
                <td>Remove control.</td>
              </tr>
            
              <tr class="even">
                <td><code>start(<span class="type">operations:Number</span>)</code></td>
                
                  
                    <td><code>None</code></td>
                  
                
                <td>Start the progress bar.</td>
              </tr>
            
              <tr class="odd">
                <td><code>updateLoader(<span class="type">step:Number</span>)</code></td>
                
                  
                    <td><code>None</code></td>
                  
                
                <td>Update the progress with specified number of operations.</td>
              </tr>
            
          </tbody>
        </table>
      
    
      <h2><a name="ProgressbarOptions"></a>class ProgressbarOptions</h2>
      <p>This class represents optional arguments to   <code><a href="reference.html#ProgressbarControl">ProgressbarControl</a></code>,  There is no constructor for this class.  Instead, this class is instantiated as a javascript object literal.</p>
      
        <h3>Properties</h3>
        <table summary="class ProgressbarOptions - Properties" width="90%">
          
          <tbody>
            <tr>
              <th>Properties</th>
              
                
                  <th>Type</th>
                
              
              <th>Description</th>
            </tr>
            
              <tr class="odd">
                <td><code>loadstring</code></td>
                
                  
                    <td><code>String</code></td>
                  
                
                <td>Specifies the string displayed  when first starting the control, before any update.  The default value is <code>Loading...</code>.</td>
              </tr>
            
              <tr class="even">
                <td><code>width</code></td>
                
                  
                    <td><code>Number</code></td>
                  
                
                <td>Specifies, in pixels, the width of the bar.  The default value is <code>176</code>.</td>
              </tr>
            
          </tbody>
        </table>
      
    
    <!-- <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
    <script type="text/javascript">
      _uacct = "UA-964209-4";
      urchinTracker();
    </script> -->
  </body>
</html>
